Modify Customer External Params Config
This API is used to modify a single External Parameters Configuration item of its own customer entities (Sub-customer, Subscriber, Package, Plan).
|
HTTP URL |
|
|---|---|
|
POST |
/api/v2/customer/{id}/external-params-config/{id} |
The second {id} is the requested External Parameter Configuration item UUID.
Eligibility
The Requester is eligible to modify a single External Parameters Configuration item of its own customer entities (sub-customers, its own subscribers, Sell packages, Sell plans). The Requester is not eligible to modify an existing External Parameters Configuration item at any other customer level, including its own sub-customers’ entities.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
name |
String |
M |
External Parameter Configuration name. Must be unique per entity. |
|
displayName |
String |
O |
External Parameter Configuration name to display to the user |
|
Description |
String |
O |
External Parameter Configuration description |
|
isSearchable |
Boolean |
M |
Determines whether the external parameter can be found by search. True: Can be searched and retrieved by the RSQL query False: Hidden. Will not be retrieved by the RSQL query |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
content |
Object |
O |
Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
requestId |
UUID |
M |
Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed |
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
CUSTOMER_1002 |
Customer does not exist |
|
CUSTOMER_1020 |
Failed to update external params config item |
|
GLOBAL_1001 |
Service unavailable. Please try again |
Examples
Request Body
{
"name": "externalSubscriberId",
"displayName": "External Subscriber Id",
"description": "The Id of the subscriber in Helly billing system",
"isSearchable": true
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
{
"errorCode": "GLOBAL_1001",
"errorMessage": "Service unavailable. Please try again",
"content": "",
"pageable": ""
}